<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: FieldType.html 878 2015-04-17 01:32:03Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.core;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.google.common.reflect.TypeToken;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.Comparator;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.jsimpledb.parse.ParseContext;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.jsimpledb.parse.ParseUtil;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.jsimpledb.util.ByteReader;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.jsimpledb.util.ByteWriter;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span> * Defines the encoding, ordering, and range of possible values for a {@link SimpleField}.<a name="line.20"></a>
<span class="sourceLineNo">021</span> *<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;p&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span> * A {@link FieldType} maps between instances of its supported Java type and the self-delimited {@code byte[]} encoding of<a name="line.23"></a>
<span class="sourceLineNo">024</span> * those instances used in the database. The {@code byte[]} encoding also implicitly defines database the sort order<a name="line.24"></a>
<span class="sourceLineNo">025</span> * (via unsigned lexicographical ordering). This ordering is also reflected via {@link #compare compare()}.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;/p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * A {@link FieldType} also defines a mapping between Java instances and {@link String} values.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * There are two separate {@link String} forms, a regular form and a self-delimiting form.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;/p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * {@link FieldType}s have these requirements and properties:<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;ul&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *  &lt;li&gt;They have a unique {@linkplain #getName name}; typically the same as their {@linkplain #getTypeToken supported type}.&lt;/li&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *  &lt;li&gt;All possible values can be represented in Java as an instance of the associated Java type (possibly including null).&lt;/li&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *  &lt;li&gt;Instances {@linkplain #compare totally order} their Java values. If the associated Java type implements {@link Comparable},<a name="line.38"></a>
<span class="sourceLineNo">039</span> *      then the two orderings do not necessarily have to match, but they should if possible.&lt;/li&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> *  &lt;li&gt;All possible values can be encoded/decoded into a self-delimiting binary string (i.e., {@code byte[]} array)<a name="line.40"></a>
<span class="sourceLineNo">041</span> *      without losing information, and these binary strings, when sorted lexicographically using unsigned comparison,<a name="line.41"></a>
<span class="sourceLineNo">042</span> *      sort consistently with the total ordering of the corresponding Java values defined by {@link #compare compare()}.&lt;/li&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> *  &lt;li&gt;All possible values can be encoded/decoded to/from {@link String}s without losing information,<a name="line.43"></a>
<span class="sourceLineNo">044</span> *      with both a {@linkplain #toString(Object) regular string form} for non-null values and a<a name="line.44"></a>
<span class="sourceLineNo">045</span> *      {@linkplain #toParseableString self-delimiting string form} for any value (these may be the same).&lt;/li&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> *  &lt;li&gt;{@code null} may or may not be a supported value; if so, it must be handled by {@link #compare compare()} (typically<a name="line.46"></a>
<span class="sourceLineNo">047</span> *      null values sort last) and have binary and string encodings just like any other value.&lt;/li&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *  &lt;li&gt;There is a {@linkplain #getDefaultValue default value}. For types that support null, the default value must be null.&lt;/li&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> *  &lt;li&gt;An optional {@linkplain #getEncodingSignature encoding signature} protects against incompatible encodings<a name="line.49"></a>
<span class="sourceLineNo">050</span> *      when a {@link FieldType}'s binary or string encoding changes without changing the {@linkplain #getName name}.&lt;/li&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;/ul&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> *<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;p&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Two {@link FieldType} instances should be equal according to {@link #equals equals()} if only if they behave identically<a name="line.54"></a>
<span class="sourceLineNo">055</span> * with respect to all of the above.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;/p&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * A {@link FieldTypeRegistry} contains a registry of {@link FieldType}s indexed by name.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;/p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param &lt;T&gt; The associated Java type<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @see FieldTypeRegistry<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span>public abstract class FieldType&lt;T&gt; implements Comparator&lt;T&gt; {<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    /**<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * The regular expression that {@link FieldType} names must match. This pattern is the same as is required<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * for Java identifiers, except that the following additional characters are allowed after the first character:<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * dot (`.') and dash (`-'), and lastly up to 255 pairs of square brackets (`[]') to indicate an array type.<a name="line.70"></a>
<span class="sourceLineNo">071</span>     */<a name="line.71"></a>
<span class="sourceLineNo">072</span>    public static final String NAME_PATTERN = "\\p{javaJavaIdentifierStart}[-.\\p{javaJavaIdentifierPart}]*(\\[\\]){0,255}";<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>    /**<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * Type name for reference types.<a name="line.75"></a>
<span class="sourceLineNo">076</span>     */<a name="line.76"></a>
<span class="sourceLineNo">077</span>    public static final String REFERENCE_TYPE_NAME = "reference";<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>    final String name;<a name="line.79"></a>
<span class="sourceLineNo">080</span>    final TypeToken&lt;T&gt; typeToken;<a name="line.80"></a>
<span class="sourceLineNo">081</span>    final long signature;<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>// Constructors<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>    /**<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * Constructor.<a name="line.86"></a>
<span class="sourceLineNo">087</span>     *<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * @param name the name of this type<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * @param typeToken Java type for the field's values<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * @param signature binary encoding signature<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @throws IllegalArgumentException if any parameter is null<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @throws IllegalArgumentException if {@code name} is invalid<a name="line.92"></a>
<span class="sourceLineNo">093</span>     */<a name="line.93"></a>
<span class="sourceLineNo">094</span>    protected FieldType(String name, TypeToken&lt;T&gt; typeToken, long signature) {<a name="line.94"></a>
<span class="sourceLineNo">095</span>        if (name == null)<a name="line.95"></a>
<span class="sourceLineNo">096</span>            throw new IllegalArgumentException("null name");<a name="line.96"></a>
<span class="sourceLineNo">097</span>        if (!name.matches(FieldType.NAME_PATTERN))<a name="line.97"></a>
<span class="sourceLineNo">098</span>            throw new IllegalArgumentException("invalid type name `" + name + "'");<a name="line.98"></a>
<span class="sourceLineNo">099</span>        if (typeToken == null)<a name="line.99"></a>
<span class="sourceLineNo">100</span>            throw new IllegalArgumentException("null typeToken");<a name="line.100"></a>
<span class="sourceLineNo">101</span>        this.name = name;<a name="line.101"></a>
<span class="sourceLineNo">102</span>        this.typeToken = typeToken;<a name="line.102"></a>
<span class="sourceLineNo">103</span>        this.signature = signature;<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /**<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * Constructor taking a {@link Class} object.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * The {@linkplain #getName name} of this instance will be the {@linkplain Class#getName name} of the given class.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     *<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * @param type Java type for the field's values<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * @param signature binary encoding signature<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * @throws NullPointerException if {@code type} is null<a name="line.112"></a>
<span class="sourceLineNo">113</span>     */<a name="line.113"></a>
<span class="sourceLineNo">114</span>    protected FieldType(Class&lt;T&gt; type, long signature) {<a name="line.114"></a>
<span class="sourceLineNo">115</span>        this(type.getName(), TypeToken.of(type), signature);<a name="line.115"></a>
<span class="sourceLineNo">116</span>    }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>// Public methods<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>    /**<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * Get the name of this type. {@link FieldType} names must be unique in the registry.<a name="line.121"></a>
<span class="sourceLineNo">122</span>     *<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * @return this type's name<a name="line.123"></a>
<span class="sourceLineNo">124</span>     */<a name="line.124"></a>
<span class="sourceLineNo">125</span>    public String getName() {<a name="line.125"></a>
<span class="sourceLineNo">126</span>        return this.name;<a name="line.126"></a>
<span class="sourceLineNo">127</span>    }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    /**<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * Get the Java type corresponding to this type's values.<a name="line.130"></a>
<span class="sourceLineNo">131</span>     *<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * @return this type's Java type<a name="line.132"></a>
<span class="sourceLineNo">133</span>     */<a name="line.133"></a>
<span class="sourceLineNo">134</span>    public TypeToken&lt;T&gt; getTypeToken() {<a name="line.134"></a>
<span class="sourceLineNo">135</span>        return this.typeToken;<a name="line.135"></a>
<span class="sourceLineNo">136</span>    }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span>    /**<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * Get the binary encoding signature of this type.<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * &lt;p&gt;<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * The binary encoding signature is analogous to the {@code serialVersionUID} used by Java serialization.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * It represents a specific binary and/or {@link String} encoding for Java values. In the case that a {@link FieldType}<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * implementation changes its binary encoding, but not it's name, it &lt;b&gt;must&lt;/b&gt; use a new, different binary encoding<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * signature to eliminate the possibility of mixing incompatible encodings in software vs. persistent storage.<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * Typically a value of zero is used until if/when such a change occurs.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * &lt;/p&gt;<a name="line.147"></a>
<span class="sourceLineNo">148</span>     *<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * &lt;p&gt;<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * Note that another option when encodings change is simply to change the {@linkplain #getName name} of the type<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * (encoding signatures are scoped to a single {@link FieldType} name).<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * &lt;/p&gt;<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @return binary encoding signature<a name="line.154"></a>
<span class="sourceLineNo">155</span>     */<a name="line.155"></a>
<span class="sourceLineNo">156</span>    public long getEncodingSignature() {<a name="line.156"></a>
<span class="sourceLineNo">157</span>        return this.signature;<a name="line.157"></a>
<span class="sourceLineNo">158</span>    }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span>    /**<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * Read a value from the given input.<a name="line.161"></a>
<span class="sourceLineNo">162</span>     *<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * @param input byte input<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * @return field value (possibly null)<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * @throws IllegalArgumentException if invalid input is encountered<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * @throws IndexOutOfBoundsException if input is truncated<a name="line.166"></a>
<span class="sourceLineNo">167</span>     */<a name="line.167"></a>
<span class="sourceLineNo">168</span>    public abstract T read(ByteReader input);<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span>    /**<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * Write a value to the given output.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     *<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * @param writer byte output<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * @param value value to write (possibly null)<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * @throws IllegalArgumentException if {@code value} is null and this type does not support null<a name="line.175"></a>
<span class="sourceLineNo">176</span>     */<a name="line.176"></a>
<span class="sourceLineNo">177</span>    public abstract void write(ByteWriter writer, T value);<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span>    /**<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * Get the default value for this field type encoded as a {@code byte[]} array.<a name="line.180"></a>
<span class="sourceLineNo">181</span>     *<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * @return encoded default value<a name="line.182"></a>
<span class="sourceLineNo">183</span>     */<a name="line.183"></a>
<span class="sourceLineNo">184</span>    public abstract byte[] getDefaultValue();<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>
<span class="sourceLineNo">186</span>    /**<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * Read and discard a value from the given input.<a name="line.187"></a>
<span class="sourceLineNo">188</span>     *<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * @param reader byte input<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * @throws IllegalArgumentException if invalid input is encountered<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * @throws IndexOutOfBoundsException if input is truncated<a name="line.191"></a>
<span class="sourceLineNo">192</span>     */<a name="line.192"></a>
<span class="sourceLineNo">193</span>    public abstract void skip(ByteReader reader);<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span>    /**<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * Encode a non-null value as a {@link String} for later decoding by {@link #fromString fromString()}.<a name="line.196"></a>
<span class="sourceLineNo">197</span>     *<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * &lt;p&gt;<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * Each of the characters in the returned {@link String} must be one of the valid XML characters<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * (tab, newline, carriage return, &lt;code&gt;&amp;#92;u0020 - &amp;#92;ud7ff&lt;/code&gt;, and &lt;code&gt;&amp;#92;ue000 - &amp;#92;fffdf&lt;/code&gt;).<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * &lt;/p&gt;<a name="line.201"></a>
<span class="sourceLineNo">202</span>     *<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * &lt;p&gt;<a name="line.203"></a>
<span class="sourceLineNo">204</span>     * The implementation in {@link FieldType} checks that {@code value} is not null, then delegates to {@link #toParseableString}.<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * Subclasses that override this method should also override {@link #fromString fromString()}.<a name="line.205"></a>
<span class="sourceLineNo">206</span>     * &lt;/p&gt;<a name="line.206"></a>
<span class="sourceLineNo">207</span>     *<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * @param value actual value, never null<a name="line.208"></a>
<span class="sourceLineNo">209</span>     * @return string encoding of {@code value}<a name="line.209"></a>
<span class="sourceLineNo">210</span>     * @throws IllegalArgumentException if {@code value} is null<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * @see &lt;a href="http://www.w3.org/TR/REC-xml/#charsets"&gt;The XML 1.0 Specification&lt;/a&gt;<a name="line.211"></a>
<span class="sourceLineNo">212</span>     */<a name="line.212"></a>
<span class="sourceLineNo">213</span>    public String toString(T value) {<a name="line.213"></a>
<span class="sourceLineNo">214</span>        if (value == null)<a name="line.214"></a>
<span class="sourceLineNo">215</span>            throw new IllegalArgumentException("null value");<a name="line.215"></a>
<span class="sourceLineNo">216</span>        return this.toParseableString(value);<a name="line.216"></a>
<span class="sourceLineNo">217</span>    }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span>    /**<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * Parse a non-null value previously encoded by {@link #toString(Object) toString(T)}.<a name="line.220"></a>
<span class="sourceLineNo">221</span>     *<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * &lt;p&gt;<a name="line.222"></a>
<span class="sourceLineNo">223</span>     * The implementation in {@link FieldType} creates a new {@link ParseContext} based on {@code string},<a name="line.223"></a>
<span class="sourceLineNo">224</span>     * delegates to {@link #toParseableString} to parse it, and verifies that all of {@code string} was consumed<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * during the parse. Subclasses that override this method should also override {@link #toString(Object) toString(T)}.<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * &lt;/p&gt;<a name="line.226"></a>
<span class="sourceLineNo">227</span>     *<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * @param string non-null value previously encoded as a {@link String} by {@link #toString(Object) toString(T)}<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * @return actual value<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * @throws IllegalArgumentException if the input is invalid<a name="line.230"></a>
<span class="sourceLineNo">231</span>     */<a name="line.231"></a>
<span class="sourceLineNo">232</span>    public T fromString(String string) {<a name="line.232"></a>
<span class="sourceLineNo">233</span>        final ParseContext ctx = new ParseContext(string);<a name="line.233"></a>
<span class="sourceLineNo">234</span>        final T value = this.fromParseableString(ctx);<a name="line.234"></a>
<span class="sourceLineNo">235</span>        if (!ctx.isEOF()) {<a name="line.235"></a>
<span class="sourceLineNo">236</span>            throw new IllegalArgumentException("found trailing garbage starting with `"<a name="line.236"></a>
<span class="sourceLineNo">237</span>              + ParseUtil.truncate(ctx.getInput(), 20) + "'");<a name="line.237"></a>
<span class="sourceLineNo">238</span>        }<a name="line.238"></a>
<span class="sourceLineNo">239</span>        return value;<a name="line.239"></a>
<span class="sourceLineNo">240</span>    }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span>    /**<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * Encode a possibly null value as a {@link String} for later decoding by {@link #fromParseableString fromParseableString()}.<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * The string value must be &lt;i&gt;self-delimiting&lt;/i&gt;, i.e., decodable even when followed by arbitrary additional characters,<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * and must not start with whitespace or closing square bracket ({@code "]"}).<a name="line.245"></a>
<span class="sourceLineNo">246</span>     *<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * &lt;p&gt;<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * In addition, each of the characters in the returned {@link String} must be one of the valid XML characters<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * (tab, newline, carriage return, &lt;code&gt;&amp;#92;u0020 - &amp;#92;ud7ff&lt;/code&gt;, and &lt;code&gt;&amp;#92;ue000 - &amp;#92;fffdf&lt;/code&gt;).<a name="line.249"></a>
<span class="sourceLineNo">250</span>     * &lt;/p&gt;<a name="line.250"></a>
<span class="sourceLineNo">251</span>     *<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * @param value actual value (possibly null)<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * @return string encoding of {@code value}<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * @throws IllegalArgumentException if {@code value} is null and this type does not support null<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * @see &lt;a href="http://www.w3.org/TR/REC-xml/#charsets"&gt;The XML 1.0 Specification&lt;/a&gt;<a name="line.255"></a>
<span class="sourceLineNo">256</span>     */<a name="line.256"></a>
<span class="sourceLineNo">257</span>    public abstract String toParseableString(T value);<a name="line.257"></a>
<span class="sourceLineNo">258</span><a name="line.258"></a>
<span class="sourceLineNo">259</span>    /**<a name="line.259"></a>
<span class="sourceLineNo">260</span>     * Parse a value previously encoded by {@link #toParseableString toParseableString()} as a self-delimited {@link String}<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * and positioned at the start of the given parsing context.<a name="line.261"></a>
<span class="sourceLineNo">262</span>     *<a name="line.262"></a>
<span class="sourceLineNo">263</span>     * @param context parse context starting with a string previously encoded via {@link #toParseableString toParseableString()}<a name="line.263"></a>
<span class="sourceLineNo">264</span>     * @return actual value (possibly null)<a name="line.264"></a>
<span class="sourceLineNo">265</span>     * @throws IllegalArgumentException if the input is invalid<a name="line.265"></a>
<span class="sourceLineNo">266</span>     */<a name="line.266"></a>
<span class="sourceLineNo">267</span>    public abstract T fromParseableString(ParseContext context);<a name="line.267"></a>
<span class="sourceLineNo">268</span><a name="line.268"></a>
<span class="sourceLineNo">269</span>    /**<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * Verify the given object is a valid instance of this {@link FieldType}'s Java type and cast it to that type.<a name="line.270"></a>
<span class="sourceLineNo">271</span>     *<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * &lt;p&gt;<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * Note that this method must throw {@link IllegalArgumentException}, not {@link ClassCastException}<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * or {@link NullPointerException}, if {@code obj} does not have the correct type, or is an illegal null value.<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * &lt;/p&gt;<a name="line.275"></a>
<span class="sourceLineNo">276</span>     *<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * &lt;p&gt;<a name="line.277"></a>
<span class="sourceLineNo">278</span>     * This method is allowed to perform widening conversions of the object that lose no information, e.g.,<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * from {@link Integer} to {@link Long}.<a name="line.279"></a>
<span class="sourceLineNo">280</span>     * &lt;/p&gt;<a name="line.280"></a>
<span class="sourceLineNo">281</span>     *<a name="line.281"></a>
<span class="sourceLineNo">282</span>     * &lt;p&gt;<a name="line.282"></a>
<span class="sourceLineNo">283</span>     * The implementation in {@link FieldType} simply casts the value using this instance's raw Java type.<a name="line.283"></a>
<span class="sourceLineNo">284</span>     * Subclasses should override this method to implement any other restrictions, e.g., disallowing null values.<a name="line.284"></a>
<span class="sourceLineNo">285</span>     * &lt;/p&gt;<a name="line.285"></a>
<span class="sourceLineNo">286</span>     *<a name="line.286"></a>
<span class="sourceLineNo">287</span>     * @param obj object to validate<a name="line.287"></a>
<span class="sourceLineNo">288</span>     * @return {@code obj} cast to this field's type<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * @throws IllegalArgumentException if {@code obj} in not of type T<a name="line.289"></a>
<span class="sourceLineNo">290</span>     * @throws IllegalArgumentException if {@code obj} is null and this type does not support null values<a name="line.290"></a>
<span class="sourceLineNo">291</span>     * @throws IllegalArgumentException if {@code obj} is in any other way not supported by this {@link FieldType}<a name="line.291"></a>
<span class="sourceLineNo">292</span>     */<a name="line.292"></a>
<span class="sourceLineNo">293</span>    @SuppressWarnings("unchecked")<a name="line.293"></a>
<span class="sourceLineNo">294</span>    public T validate(Object obj) {<a name="line.294"></a>
<span class="sourceLineNo">295</span>        try {<a name="line.295"></a>
<span class="sourceLineNo">296</span>            return (T)this.typeToken.getRawType().cast(obj);<a name="line.296"></a>
<span class="sourceLineNo">297</span>        } catch (ClassCastException e) {<a name="line.297"></a>
<span class="sourceLineNo">298</span>            throw new IllegalArgumentException(this + " does not support values of type " + obj.getClass().getName());<a name="line.298"></a>
<span class="sourceLineNo">299</span>        }<a name="line.299"></a>
<span class="sourceLineNo">300</span>    }<a name="line.300"></a>
<span class="sourceLineNo">301</span><a name="line.301"></a>
<span class="sourceLineNo">302</span>    /**<a name="line.302"></a>
<span class="sourceLineNo">303</span>     * Compare two values. This method must provide a total ordering of all supported Java values.<a name="line.303"></a>
<span class="sourceLineNo">304</span>     * If null is a supported Java value, then this method must accept it without throwing an exception<a name="line.304"></a>
<span class="sourceLineNo">305</span>     * (note, this is a stronger requirement than {@link Comparator} requires). By convention, null usually sorts last.<a name="line.305"></a>
<span class="sourceLineNo">306</span>     *<a name="line.306"></a>
<span class="sourceLineNo">307</span>     * @throws IllegalArgumentException if {@code value1} or {@code value2} is null and this type does not support null<a name="line.307"></a>
<span class="sourceLineNo">308</span>     */<a name="line.308"></a>
<span class="sourceLineNo">309</span>    @Override<a name="line.309"></a>
<span class="sourceLineNo">310</span>    public abstract int compare(T value1, T value2);<a name="line.310"></a>
<span class="sourceLineNo">311</span><a name="line.311"></a>
<span class="sourceLineNo">312</span>    /**<a name="line.312"></a>
<span class="sourceLineNo">313</span>     * Determine whether any of this field type's encoded values start with a {@code 0x00} byte.<a name="line.313"></a>
<span class="sourceLineNo">314</span>     * Certain optimizations are possible when this is not the case. It is safe for this method to always return true.<a name="line.314"></a>
<span class="sourceLineNo">315</span>     *<a name="line.315"></a>
<span class="sourceLineNo">316</span>     * &lt;p&gt;<a name="line.316"></a>
<span class="sourceLineNo">317</span>     * Note: changing the return value of this method usually means changing the binary encoding, resulting in<a name="line.317"></a>
<span class="sourceLineNo">318</span>     * an incompatible type.<a name="line.318"></a>
<span class="sourceLineNo">319</span>     * &lt;/p&gt;<a name="line.319"></a>
<span class="sourceLineNo">320</span>     *<a name="line.320"></a>
<span class="sourceLineNo">321</span>     * &lt;p&gt;<a name="line.321"></a>
<span class="sourceLineNo">322</span>     * The implementation in {@link FieldType} returns {@code true}.<a name="line.322"></a>
<span class="sourceLineNo">323</span>     * &lt;/p&gt;<a name="line.323"></a>
<span class="sourceLineNo">324</span>     *<a name="line.324"></a>
<span class="sourceLineNo">325</span>     * @return true if an encoded value starting with {@code 0x00} exists<a name="line.325"></a>
<span class="sourceLineNo">326</span>     */<a name="line.326"></a>
<span class="sourceLineNo">327</span>    public boolean hasPrefix0x00() {<a name="line.327"></a>
<span class="sourceLineNo">328</span>        return true;<a name="line.328"></a>
<span class="sourceLineNo">329</span>    }<a name="line.329"></a>
<span class="sourceLineNo">330</span><a name="line.330"></a>
<span class="sourceLineNo">331</span>    /**<a name="line.331"></a>
<span class="sourceLineNo">332</span>     * Determine whether any of this field type's encoded values start with a {@code 0xff} byte.<a name="line.332"></a>
<span class="sourceLineNo">333</span>     * Certain optimizations are possible when this is not the case. It is safe for this method to always return true.<a name="line.333"></a>
<span class="sourceLineNo">334</span>     *<a name="line.334"></a>
<span class="sourceLineNo">335</span>     * &lt;p&gt;<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * Note: changing the return value of this method usually means changing the binary encoding, resulting in<a name="line.336"></a>
<span class="sourceLineNo">337</span>     * an incompatible type.<a name="line.337"></a>
<span class="sourceLineNo">338</span>     * &lt;/p&gt;<a name="line.338"></a>
<span class="sourceLineNo">339</span>     *<a name="line.339"></a>
<span class="sourceLineNo">340</span>     * &lt;p&gt;<a name="line.340"></a>
<span class="sourceLineNo">341</span>     * The implementation in {@link FieldType} returns {@code true}.<a name="line.341"></a>
<span class="sourceLineNo">342</span>     * &lt;/p&gt;<a name="line.342"></a>
<span class="sourceLineNo">343</span>     *<a name="line.343"></a>
<span class="sourceLineNo">344</span>     * @return true if an encoded value starting with {@code 0xff} exists<a name="line.344"></a>
<span class="sourceLineNo">345</span>     */<a name="line.345"></a>
<span class="sourceLineNo">346</span>    public boolean hasPrefix0xff() {<a name="line.346"></a>
<span class="sourceLineNo">347</span>        return true;<a name="line.347"></a>
<span class="sourceLineNo">348</span>    }<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span>    /**<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * Convenience method for generic type binding.<a name="line.351"></a>
<span class="sourceLineNo">352</span>     *<a name="line.352"></a>
<span class="sourceLineNo">353</span>     * @param obj object to validate<a name="line.353"></a>
<span class="sourceLineNo">354</span>     * @throws IllegalArgumentException if {@code obj} in not of type T<a name="line.354"></a>
<span class="sourceLineNo">355</span>     * @throws IllegalArgumentException if {@code obj} is null and this type does not support null values<a name="line.355"></a>
<span class="sourceLineNo">356</span>     * @throws IllegalArgumentException if {@code obj} is in any other way not supported by this {@link FieldType}<a name="line.356"></a>
<span class="sourceLineNo">357</span>     */<a name="line.357"></a>
<span class="sourceLineNo">358</span>    void validateAndWrite(ByteWriter writer, Object obj) {<a name="line.358"></a>
<span class="sourceLineNo">359</span>        this.write(writer, this.validate(obj));<a name="line.359"></a>
<span class="sourceLineNo">360</span>    }<a name="line.360"></a>
<span class="sourceLineNo">361</span><a name="line.361"></a>
<span class="sourceLineNo">362</span>// Object<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span>    @Override<a name="line.364"></a>
<span class="sourceLineNo">365</span>    public String toString() {<a name="line.365"></a>
<span class="sourceLineNo">366</span>        return "field type `" + this.name + "'";<a name="line.366"></a>
<span class="sourceLineNo">367</span>    }<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span>    @Override<a name="line.369"></a>
<span class="sourceLineNo">370</span>    public int hashCode() {<a name="line.370"></a>
<span class="sourceLineNo">371</span>        return this.name.hashCode() ^ this.typeToken.hashCode();<a name="line.371"></a>
<span class="sourceLineNo">372</span>    }<a name="line.372"></a>
<span class="sourceLineNo">373</span><a name="line.373"></a>
<span class="sourceLineNo">374</span>    @Override<a name="line.374"></a>
<span class="sourceLineNo">375</span>    public boolean equals(Object obj) {<a name="line.375"></a>
<span class="sourceLineNo">376</span>        if (obj == this)<a name="line.376"></a>
<span class="sourceLineNo">377</span>            return true;<a name="line.377"></a>
<span class="sourceLineNo">378</span>        if (obj == null || obj.getClass() != this.getClass())<a name="line.378"></a>
<span class="sourceLineNo">379</span>            return false;<a name="line.379"></a>
<span class="sourceLineNo">380</span>        final FieldType&lt;?&gt; that = (FieldType&lt;?&gt;)obj;<a name="line.380"></a>
<span class="sourceLineNo">381</span>        return this.name.equals(that.name) &amp;&amp; this.typeToken.equals(that.typeToken);<a name="line.381"></a>
<span class="sourceLineNo">382</span>    }<a name="line.382"></a>
<span class="sourceLineNo">383</span>}<a name="line.383"></a>
<span class="sourceLineNo">384</span><a name="line.384"></a>




























































</pre>
</div>
</body>
</html>
